feat(vue-hooks): add hooks package packaging logic #2866
Conversation
WalkthroughThe pull request updates the Vue Hooks package by modifying its build and testing configurations. In the package.json file, the "module" field is removed; scripts have been updated to include a Vitest test command, along with new build and publish scripts. Additionally, the configuration now explicitly defines the package entry point via a "main" field and introduces devDependencies for development tooling. New TypeScript configuration files (tsconfig.json and tsconfig.node.json) and a Vite configuration file have also been added to streamline compilation and bundling. Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant PKG as package.json
participant Vite as Vite Build Process
participant Plugin as DTS Plugin
Dev->>PKG: Run "npm run build"
PKG->>Vite: Execute "vite build"
Vite->>Plugin: Generate type declarations via vite-plugin-dts
Vite->>Vite: Bundle library per configuration (external dependencies, input: index.ts)
Vite-->>PKG: Output bundled files to dist/ (entry: index.js)
Dev->>PKG: Optionally run "npm run pub" to publish package
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
✨ Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
WalkthroughThis PR introduces the packaging logic for the Changes
|
![petercat-assistant[bot]](https://avatars.githubusercontent.com/in/875736?s=60&v=4){kind=small}
|
[e2e-test-warn] The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug". Please make sure you've read our contributing guide |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
packages/vue-hooks/vite.config.ts (2)
1-6: Enhance vite-plugin-dts configuration for better TypeScript support.The current configuration lacks important options for TypeScript declaration file generation. Consider adding the following configurations to improve type generation:
- plugins: [dts()], + plugins: [ + dts({ + tsConfigFilePath: './tsconfig.json', + outDir: 'dist/types', + skipDiagnostics: false, + rollupTypes: true + }) + ],
8-10: Remove redundant entry point configuration.The entry point 'index.ts' is specified twice in the configuration. This is redundant and could lead to confusion.
lib: { - entry: ['index.ts'] + entry: 'index.ts' }, rollupOptions: { external: [/@opentiny/, /@floating-ui/], - input: ['index.ts'],Also applies to: 13-13
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
packages/vue-hooks/package.json(1 hunks)packages/vue-hooks/tsconfig.json(1 hunks)packages/vue-hooks/tsconfig.node.json(1 hunks)packages/vue-hooks/vite.config.ts(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- packages/vue-hooks/tsconfig.node.json
- packages/vue-hooks/tsconfig.json
🔇 Additional comments (5)
packages/vue-hooks/package.json (4)
10-12: Scripts Update: Modernizing Build, Publish, and Test CommandsThe new "build", "pub", and "test" scripts are well-defined. Using "vite build" for the build process and "vitest" for testing aligns with a modern Vue/TypeScript workflow. The publish script disables git checks (via --no-git-checks) for streamlined publishing; ensure that this role is acceptable within your release process.
15-16: Publish Configuration ConsistencyThe "publishConfig" now sets "main" to "dist/index.js" and keeps "access" as "public", which is great for specifying the built entry point when publishing. However, note that the root-level "main" field on line 8 is still set to "index.ts". Maintaining consistency between these two could prevent confusion during module resolution. Consider aligning the root "main" field with the publish configuration if the built output is intended to be consumed.
18-21: Dependency Version Resolution via WorkspacesThe dependency "@opentiny/utils" is now specified with "workspace:~". This is a valid approach in a PNPM-managed monorepo; however, please confirm that your tooling reliably resolves this version during the build process.
22-27: Custom Version Specifiers in DevDependenciesThe addition of "devDependencies" for "typescript", "vite", "vite-plugin-dts", and "vitest" broadens the tooling base for development and building. The use of custom version specifiers like "catalog:" for "typescript", "vite", and "vitest" is uncommon. Please ensure that these identifiers are intentional, documented, and properly resolved by your package manager. If these values serve as placeholders or custom resolution paths, providing clarity (in comments or documentation) would help maintainability.
packages/vue-hooks/vite.config.ts (1)
7-22: Add missing build configuration options.Consider adding the following build options to improve the output:
build: { + outDir: 'dist', + sourcemap: true, + minify: 'esbuild', lib: { entry: 'index.ts' },Verify external dependencies configuration.
Please ensure all dependencies are correctly marked as external. Run this script to verify:
✅ Verification successful
🏁 Script executed:
#!/bin/bash # Check package.json for dependencies that should be marked as external jq -r '.dependencies, .peerDependencies | keys[]' packages/vue-hooks/package.json 2>/dev/null || echo "No package.json found" # Search for imports in the source code echo "Imports found in source code:" rg -t ts "^import.*from.*['\"](@|vue)" packages/vue-hooks/src/Length of output: 1327
Build configuration enhancements and verified external dependencies
• The external dependencies (@floating-ui/dom and @opentiny/utils) imported in the source code match the regular expressions configured in the Vite config.
• The build configuration, however, is missing optional parameters such as outDir, sourcemap, and minify. Adding these will improve the output as suggested.
PR
添加vue-hooks包构建打包逻辑
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information
Summary by CodeRabbit
New Features
Chores